merchant string (32,36)
Master Merchant token
Onboarding
Onboarding
Welcome to Paynetics' onboarding section. We are happy to have you and your customers on board!
Through Paynetics, you can:
- Open accounts
- Make transfers
- Issue cards and control them
- Use our acquiring services
- Onboard merchants
- Use our white-label wallet solution for added value and convenience
We provide APIs for easy integration and usage of our capabilities If your process is not ready for full API automation, we have the tools to enable your employees to use it manually:
- our onboarding portal
- our card management portal
Collecting Data
Paynetics is a licensed EMI (Electronic Money Institution) institution, which means we need to maintain your and our partner’s trust. Paynetics is legally obliged to collect data.
There are three factors which determine what type of data we need to collect:
- What type of clients do you intend to onboard (Individuals/Legal Entities)?
- Which of our products do you wish to access?
- What is your current onboarding process?
Paynetics will provide a list of all mandatory fields and create a configuration for your profile based on the initial agreement. Once mandatory data fields are defined, you can test our offering and decide when to move forward with live implementation.
Legal Entities Onboarding
Onboarding legal entities at Paynetics can be an automatic or semi-automatic process.
Automatic onboarding process utilizes a predefined ruleset of operations, which guide the end decision of every application.
Semi-automatic onboarding process offers assisted manual review by Paynetics' underwriting specialists. This is done after the automatic checks. This allows for a better understanding of the legal entity’s structure and background.
Note - Depending on the initial agreement Paynetics may recommend one of the two solutions above.
Submitting Application
By submitting a request with the predefined mandatory fields. Refer to the example for the correct structure of the request. Once the request is received, Paynetics system will check the submitted fields and validate the input. Requests with invalid or missing fields will return an error prompting an update.
Automatic Checks
Once fields are validated, Paynetics system will perform a series of automatic checks, which can be:
- Risk Calculation - Paynetics calculates the risk profile of each new application based on provided data.
- Automatic Verification - Paynetics uses a third-party provider to extract information from local trade registration bureaus to verify company details.
- Security Checks - Paynetics uses a third-party provider to screen every new entity for adverse media and sanction lists presence.
Results
Automation results are asynchronous and are received via webhook. Once automatic checks have concluded, Paynetics system will be configured to perform different operations depending on your initial agreement.
Acquiring
Paynetics system will assign and provide a unique Merchant ID (MID) and Terminal ID (TID) via webhook. Once received they are active and can be used via Paynetics API for operations and 3DS registration.
Account Opening and Issuing
Paynetics system will provide a unique merchant identifier(token), which allows an account to be created.
Endpoint
POST /v3/applications
Operation
application_create
Request Structure
products array (1,5)
Available Options: pos , e-commerce , qr , account-opening , card-issuingdue_diligence string (0,any)
Available Options: SDD , CDDpayout_details array[object]
amount number (0,any)
Minimum amount for payout
currency string (0,any)
ISO 4217 alpha 3
iban string (0,any)
Valid IBAN to which the funds will be send
sort_code string (6,6)
Valid UK sort code
account_number string (8,8)
UK Account number
period string (0,any)
When the payout must be done
delay string (0,any)
Payout delay in days
ip_address string (0,any)
IP Address of customer submitted application
fingerprint string (0,any)
Device fingerprint of the customer submitted application
Request
Response Structure
code integer (0,any)
Response
Errors
11001 |
Validation error |
|---|
11008 |
Validator configuration not found |
|---|
Company Details
You can add or change company details via Paynetics' API. Supported operations:
- Add documents
- Change contact details
- Add/Suspend company members
- Add documents related to company members
Please refer to the example for how to change company details.
Updating Company Details
Endpoint
PUT /v3/applications/{application}/companies
Operation
company_update
Parameters
[ application ]
Request Structure
trade_name string (0,any)
Doing business as
legal_name string (0,any)
Legal name as appears in trade reigster
website string (0,any)
URL of the website
phone string (0,any)
Phone of the company
mobile_phone string (0,any)
Mobile phone of the company
country string (2,2)
Country of the company. Format: ISO 3166-1 alpha-2
county string (0,any)
Country region of the company
city string (0,any)
City where company is registerd
zip string (0,any)
Postal/ZIP Code
address1 string (0,any)
Address of the company
address2 string (0,any)
Additional details for the address
contact_email string (0,any)
Correspondence email address
correspondence_address string (0,any)
Correspondence phisical address
description_of_activity string (0,any)
Description of the business activity of the company
address_of_shop string (0,any)
Address of the phisical shop/office of the company
business_activity string (0,any)
More details in nomernclutres section
is_sie boolean
In case the company appears in any sanctions list the field must be marked as true
Request
Response Structure
code integer (0,any)
Response
Errors
11001 |
Validation error |
|---|
11002 |
Application not found |
|---|
Adding Company Document
Endpoint
POST /v3/applications/{application}/companies/documents
Operation
company_add_document
Parameters
[ application ]
Request Structure
file string (0,any)
Base64 encoded file
file_type string (0,any)
Type of the file
Available Options: pdf , docx , xlxs , jpg , jpeg , png , mov , mp4document_type string (0,any)
More details in nomenclatures section
Available Options: idcard , bankstmt , bill , other , idcard-front , idcard-back , idcard-selfie , passport-back , passport-selfie , passport , driving-license-selfie , selfie , driving-license-front , driving-license-back , sharebook-excerpt , management-contract , moms-of-the-board , activity-license , bank-account , bulstat-registration , vat-registration , patent-law , power-of-attorney , ubo-declaration , frame-contract , sample-of-signatures , face-compare , proof , recent-excerpt , incorporation-documents , share_holders_list , other_corporate , signature , id_card_passport_photo , biometric-residence-permit-front , biometric-residence-permit-back , kyc-vendor-report , fatca-declaration , sow-declaration , sof-desclaration , resident-permit-eu-uk-front , resident-permit-eu-uk-backRequest
Response Structure
code integer (0,any)
Response
Errors
11001 |
Validation error |
|---|
11002 |
Application not found |
|---|
Adding Company member
Endpoint
POST /v3/applications/{application}/companies/members
Operation
company_add_member
Parameters
[ application ]
Request Structure
first_name string (0,any)
First name of the member
last_name string (0,any)
Last name of the member
mobile_phone string (0,any)
Mobile phone of the member
phone string (0,any)
Phone of the member
legal_name string (0,any)
Used when member is other legal entity
uic string (0,any)
Business registration number.Used when member is other legal entity
country string (0,any)
Country of birth or country of legal entity.ISO 3166-1 alpha-2
country_of_residence string (0,any)
ISO 3166-1 alpha-2
zip string (0,any)
Postal/Zip code of the member.
city string (0,any)
City of the member.
address1 string (0,any)
Address of the member.
address2 string (0,any)
Additional info for the address
county string (0,any)
Region of the member
ownership boolean
Only for UBO to specify the percentage of the ownership
ownership_percentage integer (0,any)
Only for UBO to specify the percentage of the ownership
type array (1,2)
Available Options: ubo , ceo , representative , proxy , legal-entity , officerunique_identifier string (0,any)
Unique number of persons on offical document.
user string (0,any)
Existing user in Paynetics system to get KYC details
legal_form string (0,any)
Legal form of the company
Available Options: sole-trader , limited-company , limited-partnership , limited-liability-partnership , other , self-employedplace_of_birth string (0,any)
ISO 3166-1 alpha-2
pep_declaration boolean
Mark as PEP
pep_related_declaration boolean
Mark as PEP relative
is_sip boolean
Mark as that appears in sanction lists
birthday string (0,any)
Date of birth
nationality string (0,any)
ISO 3166-1 alpha-2
contact_email string (0,any)
documents array[object]
file string (0,any)
Base64 encoded file
file_type string (0,any)
Type of the file
Available Options: pdf , docx , xlxs , jpg , jpeg , png , mov , mp4document_type string (0,any)
More details in nomenclatures section
Available Options: idcard , bankstmt , bill , other , idcard-front , idcard-back , idcard-selfie , passport-back , passport-selfie , passport , driving-license-selfie , selfie , driving-license-front , driving-license-back , sharebook-excerpt , management-contract , moms-of-the-board , activity-license , bank-account , bulstat-registration , vat-registration , patent-law , power-of-attorney , ubo-declaration , frame-contract , sample-of-signatures , face-compare , proof , recent-excerpt , incorporation-documents , share_holders_list , other_corporate , signature , id_card_passport_photo , biometric-residence-permit-front , biometric-residence-permit-back , kyc-vendor-report , fatca-declaration , sow-declaration , sof-desclaration , resident-permit-eu-uk-front , resident-permit-eu-uk-backRequest
Response Structure
code integer (0,any)
Response
Errors
11001 |
Validation error |
|---|
11002 |
Application not found |
|---|
Updating Company member
Endpoint
PUT /v3/applications/{application}/companies/members/{token}
Operation
company_member_update
Parameters
[ application ]
[ token ]
Request Structure
first_name string (0,any)
First name of the member
last_name string (0,any)
Last name of the member
mobile_phone string (0,any)
Mobile phone of the member
phone string (0,any)
Phone of the member
legal_name string (0,any)
Used when member is other legal entity
country string (0,any)
Country of birth or country of legal entity.ISO 3166-1 alpha-2
country_of_residence string (0,any)
ISO 3166-1 alpha-2
zip string (0,any)
Postal/Zip code of the member.
city string (0,any)
City of the member.
address1 string (0,any)
Address of the member.
address2 string (0,any)
Additional info for the address
county string (0,any)
Region of the member
ownership boolean
Only for UBO to specify the percentage of the ownership
ownership_percentage integer (0,any)
Only for UBO to specify the percentage of the ownership
legal_form string (0,any)
Legal form of the company
Available Options: sole-trader , limited-company , limited-partnership , limited-liability-partnership , other , self-employedpep_declaration boolean
Mark as PEP
pep_related_declaration boolean
Mark as PEP relative
is_sip boolean
Mark as that appears in sanction lists
contact_email string (0,any)
status string (0,any)
Available Options: active , inactiveRequest
Response Structure
code integer (0,any)
Response
Errors
11001 |
Validation error |
|---|
11002 |
Company member not found |
|---|
Add Company member document
Endpoint
POST /v3/applications/{application}/companies/members/{token}/documents
Operation
company_member_add_document
Parameters
[ application ]
[ token ]
Request Structure
file string (0,any)
Base64 encoded file
file_type string (0,any)
Type of the file
Available Options: pdf , docx , xlxs , jpg , jpeg , png , mov , mp4document_type string (0,any)
More details in nomenclatures section
Available Options: idcard , bankstmt , bill , other , idcard-front , idcard-back , idcard-selfie , passport-back , passport-selfie , passport , driving-license-selfie , selfie , driving-license-front , driving-license-back , sharebook-excerpt , management-contract , moms-of-the-board , activity-license , bank-account , bulstat-registration , vat-registration , patent-law , power-of-attorney , ubo-declaration , frame-contract , sample-of-signatures , face-compare , proof , recent-excerpt , incorporation-documents , share_holders_list , other_corporate , signature , id_card_passport_photo , biometric-residence-permit-front , biometric-residence-permit-back , kyc-vendor-report , fatca-declaration , sow-declaration , sof-desclaration , resident-permit-eu-uk-front , resident-permit-eu-uk-backRequest
Response Structure
code integer (0,any)
Response
Errors
11001 |
Validation error |
|---|
11002 |
Company member not found |
|---|
Users
Create Natural Person
Endpoint
POST /v2/users
Operation
user_create
Request Structure
email string (0,any)
Email address of the user
first_name string (0,any)
First name of the user
last_name string (0,any)
Last name of the user
address1 string (0,any)
Address of the user
address2 string (0,any)
country string (0,any)
Country of resident of the user (Alpha-2)
city string (0,any)
City of the user
zip string (0,any)
ZIP/Postal Code of the user
phone string (0,any)
Phone of the user
mobile_phone string (0,any)
Mobile Phone of the user
language string (0,any)
nationality string (0,any)
Nationality of the user (Alpha-2)
birthday string (0,any)
Date of birth of the user (YYYY-MM-DD)
aml string (0,any)
place_of_birth string (0,any)
merchant string (32,36)
Master Merchant token
occupation string (0,any)
other_occupation string (0,255)
Other occupation (free text field)
education string (0,any)
info string (0,any)
money_declaration string (0,any)
source_of_funds string (0,any)
other_source_of_funds string (0,255)
Other source of funds (free text field)
external_reference string (0,any)
registration_ip string (0,any)
is_san string (0,any)
is_sip string (0,any)
peps_declaration string (0,any)
pep string (0,any)
pep_relative string (0,any)
unique_identifier string (0,any)
id_passport_validity string (0,any)
id_passport_number string (0,any)
type string (0,any)
Available Options: card-usage , defaultdocuments array[object]
file string (0,any)
Base64 encoded file
file_type string (0,any)
Type of the file
Available Options: pdf , docx , xlxs , jpg , jpeg , png , mov , mp4document_type string (0,any)
More details in nomenclatures section
Available Options: idcard , bankstmt , bill , other , idcard-front , idcard-back , idcard-selfie , passport-back , passport-selfie , passport , driving-license-selfie , selfie , driving-license-front , driving-license-back , sharebook-excerpt , management-contract , moms-of-the-board , activity-license , bank-account , bulstat-registration , vat-registration , patent-law , power-of-attorney , ubo-declaration , frame-contract , sample-of-signatures , face-compare , proof , recent-excerpt , incorporation-documents , share_holders_list , other_corporate , signature , id_card_passport_photo , biometric-residence-permit-front , biometric-residence-permit-back , kyc-vendor-report , fatca-declaration , sow-declaration , sof-desclaration , resident-permit-eu-uk-front , resident-permit-eu-uk-backmiddle_name string (0,255)
Middle name of the user
proof_of_identity_type string (0,100)
Type of identity document
Available Options: ID , Passport , Driving license – UK only , Otherid_issue_date string (0,any)
Date when ID was issued
country_issuing_id_card string (0,2)
Country that issued the ID card (ISO 3166-1 alpha-2)
additional_nationality array (0,any)
Additional nationalities (ISO 3166-1 alpha-2)
purpose_of_wallet_usage array (0,any)
Purpose of wallet usage
other_purpose_of_wallet_usage string (0,255)
Other purpose of wallet usage (free text field)
occupation_position string (0,255)
Occupation position
Available Options: Manager , Professional , Technicians and associate professional , Clerical support worker , Service and sales worker , Skilled agricultural, forestry and fishery worker , Craft and related trades worker , Plant and machine operator, and assemblers , Elementary occupation , NOT APPLICABLEemployment_status string (0,255)
Employment status
Available Options: Private sector employee , Government sector or local authority employee , Self-employed individual/professional , Business owner , Student , Retired , Unemployed , Other (please specify)other_employment_status string (0,255)
Other employment status (free text field)
client_monthly_net_income string (0,255)
Client monthly net income
Available Options: Less than 1000 EUR , Between 1001 and 5000 EUR , Between 5001 and 10000 EUR , Between 10001 and 15000 EUR , More than 15 000 EURexpected_incoming_monthly_eur string (0,255)
Expected incoming monthly EUR
Available Options: Less than 1000 EUR , Between 1001 and 5000 EUR , Between 5001 and 10000 EUR , Between 10001 and 15000 EUR , More than 15 000 EURexpected_outgoing_monthly_eur string (0,255)
Expected outgoing monthly EUR
Available Options: Less than 1000 EUR , Between 1001 and 5000 EUR , Between 5001 and 10000 EUR , Between 10001 and 15000 EUR , More than 15 000 EURtype_of_incoming_funds array (0,any)
Type of incoming funds
expected_monthly_frequency_incoming_transfer string (0,255)
Expected monthly frequency of incoming transfers
Available Options: Less than 2 times , Between 3-5 times , More than 6 timessanction_media_screening boolean
Sanction media screening
risk_score string (0,100)
Risk score (Low, Medium, High)
Available Options: Low , Medium , Highvulnerability_type string (0,any)
Vulnerability type
accessibility_required string (0,any)
Accessibility required
specified_us_person boolean
Specified US person
company string (0,any)
Request
Errors
-2 |
Duplicate User |
|---|
-3 |
Validation Error |
|---|
Update Natural Person
Endpoint
PUT /v2/users/{user}
Operation
user_update
Parameters
[ user ]
Token from user creation
Request Structure
first_name string (0,any)
First name of the user
last_name string (0,any)
Last name of the user
address1 string (0,any)
Address of the user
address2 string (0,any)
country string (0,any)
Country of resident of the user (Alpha-2)
city string (0,any)
City of the user
zip string (0,any)
ZIP/Postal Code of the user
phone string (0,any)
Phone of the user
mobile_phone string (0,any)
Mobile Phone of the user
language string (0,any)
nationality string (0,any)
Nationality of the user (Alpha-2)
birthday string (0,any)
Date of birth of the user (YYYY-MM-DD)
place_of_birth string (0,any)
merchant string (32,36)
Master Merchant token
occupation string (0,any)
other_occupation string (0,255)
Other occupation (free text field)
education string (0,any)
info string (0,any)
money_declaration string (0,any)
source_of_funds string (0,any)
other_source_of_funds string (0,255)
Other source of funds (free text field)
external_reference string (0,any)
is_san string (0,any)
is_sip string (0,any)
peps_declaration string (0,any)
pep string (0,any)
pep_relative string (0,any)
unique_identifier string (0,any)
id_passport_validity string (0,any)
id_passport_number string (0,any)
middle_name string (0,255)
Middle name of the user
proof_of_identity_type string (0,100)
Type of identity document
Available Options: ID , Passport , Driving license – UK only , Otherid_issue_date string (0,any)
Date when ID was issued
country_issuing_id_card string (0,2)
Country that issued the ID card (ISO 3166-1 alpha-2)
additional_nationality array (0,any)
Additional nationalities (ISO 3166-1 alpha-2)
purpose_of_wallet_usage array (0,any)
Purpose of wallet usage
other_purpose_of_wallet_usage string (0,255)
Other purpose of wallet usage (free text field)
occupation_position string (0,255)
Occupation position
Available Options: Manager , Professional , Technicians and associate professional , Clerical support worker , Service and sales worker , Skilled agricultural, forestry and fishery worker , Craft and related trades worker , Plant and machine operator, and assemblers , Elementary occupation , NOT APPLICABLEemployment_status string (0,255)
Employment status
Available Options: Private sector employee , Government sector or local authority employee , Self-employed individual/professional , Business owner , Student , Retired , Unemployed , Other (please specify)other_employment_status string (0,255)
Other employment status (free text field)
client_monthly_net_income string (0,255)
Client monthly net income
Available Options: Less than 1000 EUR , Between 1001 and 5000 EUR , Between 5001 and 10000 EUR , Between 10001 and 15000 EUR , More than 15 000 EURexpected_incoming_monthly_eur string (0,255)
Expected incoming monthly EUR
Available Options: Less than 1000 EUR , Between 1001 and 5000 EUR , Between 5001 and 10000 EUR , Between 10001 and 15000 EUR , More than 15 000 EURexpected_outgoing_monthly_eur string (0,255)
Expected outgoing monthly EUR
Available Options: Less than 1000 EUR , Between 1001 and 5000 EUR , Between 5001 and 10000 EUR , Between 10001 and 15000 EUR , More than 15 000 EURtype_of_incoming_funds array (0,any)
Type of incoming funds
expected_monthly_frequency_incoming_transfer string (0,255)
Expected monthly frequency of incoming transfers
Available Options: Less than 2 times , Between 3-5 times , More than 6 timessanction_media_screening boolean
Sanction media screening
risk_score string (0,100)
Risk score (Low, Medium, High)
Available Options: Low , Medium , Highvulnerability_type string (0,any)
Vulnerability type
accessibility_required string (0,any)
Accessibility required
specified_us_person boolean
Specified US person
Request
Response Structure
code integer (0,any)
Response
Get Details of Natural Person
Endpoint
GET /v2/users/{user}
Operation
user_details
Parameters
[ user ]
Token from user creation
Response Structure
email string (0,any)
Email address of the user
first_name string (0,any)
First name of the user
last_name string (0,any)
Last name of the user
address1 string (0,any)
Address of the user
address2 string (0,any)
country string (0,any)
Country of resident of the user (Alpha-2)
city string (0,any)
City of the user
zip string (0,any)
ZIP/Postal Code of the user
phone string (0,any)
Phone of the user
mobile_phone string (0,any)
Mobile Phone of the user
language string (0,any)
nationality string (0,any)
Nationality of the user (Alpha-2)
birthday string (0,any)
Date of birth of the user (YYYY-MM-DD)
aml string (0,any)
place_of_birth string (0,any)
merchant string (32,36)
Master Merchant token
occupation string (0,any)
other_occupation string (0,255)
Other occupation (free text field)
education string (0,any)
info string (0,any)
money_declaration string (0,any)
source_of_funds string (0,any)
other_source_of_funds string (0,255)
Other source of funds (free text field)
external_reference string (0,any)
registration_ip string (0,any)
is_san string (0,any)
is_sip string (0,any)
peps_declaration string (0,any)
pep string (0,any)
pep_relative string (0,any)
unique_identifier string (0,any)
id_passport_validity string (0,any)
id_passport_number string (0,any)
type string (0,any)
Available Options: card-usage , defaultmiddle_name string (0,255)
Middle name of the user
proof_of_identity_type string (0,100)
Type of identity document
Available Options: ID , Passport , Driving license – UK only , Otherid_issue_date string (0,any)
Date when ID was issued
country_issuing_id_card string (0,2)
Country that issued the ID card (ISO 3166-1 alpha-2)
additional_nationality array (0,any)
Additional nationalities (ISO 3166-1 alpha-2)
purpose_of_wallet_usage array (0,any)
Purpose of wallet usage
other_purpose_of_wallet_usage string (0,255)
Other purpose of wallet usage (free text field)
occupation_position string (0,255)
Occupation position
Available Options: Manager , Professional , Technicians and associate professional , Clerical support worker , Service and sales worker , Skilled agricultural, forestry and fishery worker , Craft and related trades worker , Plant and machine operator, and assemblers , Elementary occupation , NOT APPLICABLEemployment_status string (0,255)
Employment status
Available Options: Private sector employee , Government sector or local authority employee , Self-employed individual/professional , Business owner , Student , Retired , Unemployed , Other (please specify)other_employment_status string (0,255)
Other employment status (free text field)
client_monthly_net_income string (0,255)
Client monthly net income
Available Options: Less than 1000 EUR , Between 1001 and 5000 EUR , Between 5001 and 10000 EUR , Between 10001 and 15000 EUR , More than 15 000 EURexpected_incoming_monthly_eur string (0,255)
Expected incoming monthly EUR
Available Options: Less than 1000 EUR , Between 1001 and 5000 EUR , Between 5001 and 10000 EUR , Between 10001 and 15000 EUR , More than 15 000 EURexpected_outgoing_monthly_eur string (0,255)
Expected outgoing monthly EUR
Available Options: Less than 1000 EUR , Between 1001 and 5000 EUR , Between 5001 and 10000 EUR , Between 10001 and 15000 EUR , More than 15 000 EURtype_of_incoming_funds array (0,any)
Type of incoming funds
expected_monthly_frequency_incoming_transfer string (0,255)
Expected monthly frequency of incoming transfers
Available Options: Less than 2 times , Between 3-5 times , More than 6 timessanction_media_screening boolean
Sanction media screening
risk_score string (0,100)
Risk score (Low, Medium, High)
Available Options: Low , Medium , Highvulnerability_type string (0,any)
Vulnerability type
accessibility_required string (0,any)
Accessibility required
specified_us_person boolean
Specified US person
Response
Remove Natural Person
Endpoint
DELETE /v2/users/{user}
Operation
user_remove
Parameters
[ user ]
Token from user creation
Response Structure
code integer (0,any)
Response
AML Natural Persons
You can check AML and sanctions presence:
AML Check
Endpoint
POST /v1/aml
Operation
aml_check
Request Structure
first_name string (0,any)
last_name string (0,any)
nationality string (0,any)
birthday string (0,any)
Request
Response Structure
code integer (0,any)
Response
Errors
18000 |
services.general.invalid_processor |
|---|
18001 |
service.aml.match.found |
|---|
Know your customer
KYC Introduction
Endpoint
POST /v1/kyc
Operation
kyc_init
Request Structure
user string (0,any)
Token of the user
Request
Response Structure
code integer (0,any)
Response
Errors
11002 |
payoo.users.not_found |
|---|
KYC Identification
Endpoint
Operation